今天針對要測試 Call API 是否符合預期來做了解,我們可以怎麼做。
Mocking Service Worker(MSW) 是什麼?
MSW 的基礎設定。
昨天有提到 Jest Mocking 不會直接 Call API 進行測試。那如果我就是希望要測試 Call API 是否符合預期呢?
-- | Mocking Service Worker(MSW) | Jest Mock Functions |
---|---|---|
測試內容 | 專注在 HTTP Request 或 Response 是否符合預期。 | 專注在函式或模組執行結果是否符合預期。 |
測試涉及 HTTP Request? | O | X |
測試會送出 HTTP Request? | X | X |
測試層級 | Network Layer Mocking | Module Layer Mocking |
補充 | 可以依據 Request Method 與 URL,更真實模擬 Call API 行爲。 | 主要用於單元測試和集成測試。 |
MSW 官網 提供的 SetUp 步驟很清楚,進行:
// src/mocks/server.ts
import { setupServer } from 'msw/node'
import { handlers } from './handlers'
// This configures a request mocking server with the given request handlers.
export const server = setupServer(...handlers)
rest<API Method>(<Request URL>, <Resolver Functions>)
req
, res
, ctx
req
: 模擬使用者 req 內容res
: 一個 function,模擬 Server 回傳資訊。ctx
: 提供多個回傳 statusCode、body、json data 等方法。import { rest } from 'msw';
export const handlers = [
rest.get("https://jsonplaceholder.typicode.com/users", (req, res, ctx) => {
return(
res(
ctx.status(200),
ctx.json([
{
"id": 1,
"name": "Leanne Graham",
"username": "Bret",
"email": "Sincere@april.biz",
"address": {
"street": "Kulas Light",
"suite": "Apt. 556",
"city": "Gwenborough",
"zipcode": "92998-3874",
"geo": {
"lat": "-37.3159",
"lng": "81.1496"
}
},
"phone": "1-770-736-8031 x56442",
"website": "hildegard.org",
"company": {
"name": "Romaguera-Crona",
"catchPhrase": "Multi-layered client-server neural-net",
"bs": "harness real-time e-markets"
}
},
...
])
)
)
})
];